home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-09 / joggr105.zip / JOGGER.DOC < prev    next >
Text File  |  1992-02-12  |  10KB  |  239 lines
  1.  
  2.  
  3.                 JOGGER
  4.  
  5.                   by
  6.  
  7.                   Mark Hobart
  8.  
  9.                   February 1992
  10.  
  11.  
  12.  
  13. Introduction
  14. ------------
  15.  
  16. This file contains instructions on installation and operation of JOGGER.
  17. To install and run JOGGER create a directory called jogger and copy all
  18. files in this posting to it. The manifest is
  19.  
  20.     jogger.exe         the binary
  21.     runs.dat        run database (sample)
  22.     courses.dat        courses database (sample)
  23.     README            overview and ShareWare details
  24.     CHANGES            list of changes made in past versions
  25.     CATALOG            list of software available from me.
  26.     jogger.doc        this file
  27.         jogger.ico        Windows icon
  28.     jogger.pif        Windows .pif file
  29.  
  30.  
  31. Note, licensed users will also receive a file called "license.txt".
  32.  
  33. You should now change to the jogger directory and type "jogger". For subsequent
  34. use see the installation tip at the end of this file.
  35.  
  36. JOGGER now displays information on how to become a registered user and will do
  37. so every time you access the main menu screen.  To clear the screen and proceed
  38. each time it's displayed simply click the left mouse button or press the space
  39. bar.  When you become a registered user I'll send you instructions on how to
  40. stop it by return of post. 
  41.  
  42. Main Menu screen
  43. ----------------
  44.  
  45. This screen is a top level menu and allows you to select the action you wish
  46. to perform. Simply click the left mouse button in the appropriate box or press
  47. the number of the action you desire and you'll see the action become
  48. highlighted (it's best in colour). Repeat the selection or hit RETURN or SPACE
  49. and that action is then processed. Selecting another box will highlight that
  50. option. To exit the program at this point simply click in the "Quit" box or
  51. press the "Esc" key or the letter 'q'. 
  52.  
  53. Hot Keys
  54. --------
  55. As of version 1.03 there is support for hot key sequences. This enables systems
  56. without a mouse to use JOGGER. I'll explain here the simple conventions used.
  57.  
  58. Throughout the program "Esc" can be used as a hot key for "Quit" if the option
  59. box for "Quit" is displayed.  Other hot keys are often the first letter of an
  60. option eg.  "Cancel" would be 'c' or the uppercase letter highlighted eg. 
  61. "saVe" would be 'v'.  However, the exception is "Help".  Whenever this option
  62. is displayed the hot key "F1" should be used.  Of course if you have a mouse
  63. then you can use that to select any option as well. 
  64.  
  65. Screen 1 - Enter run data
  66. -------------------------
  67.  
  68. This screen allows you to enter details of a run.  Simply type in the details
  69. requested for each boxed field.  Clicking on "help" with the mouse or using the
  70. "F1" hot key will display a pop up window that contains a list of courses and
  71. course codes in case you can't remember the code.  Once you've entered the
  72. appropriate text you'll automatically be moved to the next field. 
  73. Alternatively, typing TAB or RETURN will move you to the next field (once
  74. sufficient data has been entered for the field).  Selecting "Quit" at anytime
  75. will abort the data entry and return you to the main screen (via the annoying
  76. box of course unless you're registered).  Once all data has been entered you'll
  77. be asked if it's ok.  Clicking in the "Ok" box or hitting the RETURN key
  78. accepts the entry and adds it to the database.  Clicking "Cancel" (or pressing
  79. the 'c' key) clears the fields and allows you to re-enter the data. 
  80.  
  81. Screen 2 - Display  runs
  82. ------------------------
  83.  
  84. This screen allows you to browse through the records of the run database in
  85. forward ( select "Fwd" box) and reverse directions (select "Back" box). 
  86. Selecting "1st" will take you to the first screen and "Last" will take you to
  87. the last screenful of data (unless you're already at the end of the data of
  88. course).  Selecting the sort box changes the way the records are sorted.  You
  89. can choose between "date" i.e.  chronological order or "course/time" where
  90. records are sorted in course alphabetical order with the best time at the top
  91. and the worst at the bottom.  Selecting "Quit" at anytime returns you to the
  92. main menu screen. 
  93.  
  94. Screen 3 - Display form graph
  95. -----------------------------
  96.  
  97. This screen displays a plot of form (y-axis) against date (x-axis).  Browsing
  98. of the graph is the same as for the screen 2 controls mentioned earlier. 
  99. Selecting "Last" will give a graphical view of current form.  
  100.  
  101. Form is calculated as follows
  102.  
  103.     form = 100 -    (time - best)
  104.               (  --------------  )  * 100
  105.                         (worst - best)
  106.  
  107. Screen 4 - Remove run data
  108. --------------------------
  109.  
  110. This screen is similiar to Screen 1 but this time a valid menu entry is used
  111. to delete ALL run database records matching the code and date supplied. The
  112. "Help" box displays a list of courses and dates attempted to help you fill in
  113. the fields.
  114.  
  115. Screen 5 - Display courses
  116. --------------------------
  117.  
  118. This screen allows browsing of the courses database. It displays course
  119. information as well as best and worst times for the course. Forward browsing
  120. only is allowed in this option.
  121.  
  122. Screen 6 - Enter course data
  123. ----------------------------
  124.  
  125. This screen is the screen 1 equivalent for the courses database.  You are
  126. invited to enter a name for the course (at most 20 characters) and the distance
  127. of the course in units of your own choosing.  However it's important to be
  128. consistent, ie. if you use miles enter the distance in miles for all courses as
  129. differing distance units cause the pace times to be wildly different for each
  130. course.  The course comment is an optional field for use if you want to say
  131. something about the course.  Eg.  "I'm never doing this again!". You've got 25
  132. characters. 
  133.  
  134.  
  135. Screen 7 - Edit/Delete course data
  136. ----------------------------------
  137.  
  138. This screen allows you to edit or delete data fields for a course database
  139. entry. You're invited to enter a course code and help is provided via the
  140. "help" box. Once the code is entered all the fields are filled in for the
  141. course and you're asked whether you want to "Edit" or "Delete" the
  142. entry. If you select "Delete" then the entry will be cleared and you'll be
  143. able to enter new course data for this code at a later date. (Note the course
  144. data will not be deleted if run database records exist that still use this
  145. codes course data. If this record is to be deleted then you'll need to
  146. remove all runs for the course using screen 4).
  147.  
  148. Selecting edit moves to the name field where you can either enter a new name or
  149. hit TAB or RETURN to accept the current field value.  This happens for
  150. subsequent fields until they're all completed.  At this point you'll be asked
  151. to accept what's been entered as the new record ("Ok" box) or reject it
  152. ("Cancel" box).  As with other screens selecting "Quit" terminates
  153. the screen and returns you to the main menu. 
  154.  
  155.  
  156. Screen 8 - Report generator
  157. ---------------------------
  158.  
  159. This screen allows you to browse and save to disk reports of the run and
  160. course data. You can generate two reports; one sorted by course/time and one
  161. in chronological order. The latter generates a monthly summary whereas the
  162. former generates a summary for each course. The generated report file
  163. "course.rep" or "date.rep" respectively can then be printed if required using
  164. the MS-DOS print command. The hot key letter for saving to disk is 'v'.
  165.  
  166. As of version 1.01 there is an enhanced browsing mechanism similiar to that
  167. used in screen 2 for displaying run records.
  168.  
  169. Screen 9 - Estimate time for a run
  170. ----------------------------------
  171.  
  172. This screen allows you to get JOGGER to calculate an estimated time for a run
  173. in the courses database. You can use two techniques; either enter a sample
  174. number of runs or a form value in the range 1-100. If you use the sample
  175. number of runs field then JOGGER calculates your average form over the last
  176. 'n' runs and uses this to calculate the time you'd expect to complete the run
  177. in. If you supply a form value instead, then JOGGER uses this as the average
  178. form value in its calculations. You must enter either a form or a sample, not
  179. both.
  180.  
  181. The formula used for calculating an estimated time is as follows:-
  182.  
  183.     time = PW + ( average form  X ( PB - PW ) )
  184.                       ---------------------------
  185.                                100
  186.  
  187. (where PW - Personal worst time for run, PB - Personal best time for run).
  188.  
  189. Starting your own databases
  190. ---------------------------
  191.  
  192. Included in this posting are sample databases to help you evaluate the package. 
  193. If you're interested they're details of my runs! To start your own simply
  194. delete the "courses.dat" and "runs.dat" files and use JOGGER to enter new data. 
  195. The ".dat" files are binary files so don't try editing them! Remember to back
  196. up your database files from time to time. 
  197.  
  198.  
  199. Acknowledgements
  200. ----------------
  201.  
  202. Thanks to Alan Phillips for the mouse routines and interface suggestions.  Also
  203. Mark Anichebe for the form idea. 
  204.  
  205. Remember, "There's miles of miles!" so log 'em with JOGGER!
  206.  
  207.  
  208. Installation tip
  209. ----------------
  210. Create a jogger.bat file containing the following lines and put the file on
  211. your path. You'll then be able to run JOGGER from any directory.
  212.  
  213. cd <jogger-installation-directory>
  214. jogger
  215.  
  216.  
  217. My file contains:
  218.  
  219. cd \mark\jogger
  220. jogger
  221.  
  222.  
  223. Running JOGGER from Windows 3.0
  224. -------------------------------
  225.  
  226. If you run JOGGER from windows then, as of version 1.04, there is my little
  227. JOGGER man icon that fits nicely on any desktop which is included with the
  228. distribution. There is also a PIF file that you may find useful.
  229.  
  230. IMPORTANT!!!!
  231. -------------
  232.  
  233. If you do run JOGGER under windows then never leave it running as an ICON if
  234. you've performed some database update function. The reason being that JOGGER
  235. only updates the databases upon exit of the program. Therefore whilst it's
  236. running as an ICON under windows the databases will not be up-to-date. You've
  237. been warned...
  238.  
  239.